<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
  <head>
	<!--[if lt IE 9]>
	<script src="http://html5shiv.googlecode.com/svn/trunk/html5.js"></script>
	<![endif]-->
    <title>Order_V1 - Pws.Clients.RestLibrary Documentation</title>
    <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
    <link type="text/css" rel="stylesheet" href="../main.css"/>
    <script type="text/javascript" src="../js/jquery-1.3.2.min.js"></script>
    <script type="text/javascript" src="../js/jquery.scrollTo-min.js"></script>
    <script type="text/javascript" src="../js/navigation.js"></script>
    <script type="text/javascript" src="../js/example.js"></script>
  </head>
  <body>
  	<header><h1>Pws.Clients.RestLibrary : API Documentation</h1>
	</header>
<nav id="namespaces">
	<h2 class="fixed">Namespaces</h2>
	<div class="scroll">
		<ul>
			<li>
          <a href="../Pws.Clients.RestLibrary/index.htm">Pws.Clients.RestLibrary</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Aftersales/index.htm">Pws.Clients.RestLibrary.Aftersales</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers/index.htm">Pws.Clients.RestLibrary.Customers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Contacts/index.htm">Pws.Clients.RestLibrary.Customers.Contacts</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Orders/index.htm" class="current">Pws.Clients.RestLibrary.Customers.Orders</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Customers.Products/index.htm">Pws.Clients.RestLibrary.Customers.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Permissions/index.htm">Pws.Clients.RestLibrary.ECommerce.Permissions</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.ECommerce.Users/index.htm">Pws.Clients.RestLibrary.ECommerce.Users</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Framework/index.htm">Pws.Clients.RestLibrary.Framework</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products/index.htm">Pws.Clients.RestLibrary.Products</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Products.Navigation/index.htm">Pws.Clients.RestLibrary.Products.Navigation</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Shared/index.htm">Pws.Clients.RestLibrary.Shared</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.Suppliers/index.htm">Pws.Clients.RestLibrary.Suppliers</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceEstimator/index.htm">Pws.Clients.RestLibrary.WorksurfaceEstimator</a>
      </li>
			<li>
          <a href="../Pws.Clients.RestLibrary.WorksurfaceJobs/index.htm">Pws.Clients.RestLibrary.WorksurfaceJobs</a>
      </li>
		</ul>
	</div>
</nav><nav id="types">
  <h2 class="fixed">Types in Pws.Clients.RestLibrary.Customers.Orders</h2>
	<div class="scroll">
		<ul>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Alert_V1.htm">Alert_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeOption.htm">BespokeOption</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeQuantityDefault.htm">BespokeQuantityDefault</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/BespokeSelection.htm">BespokeSelection</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmount.htm">CurrencyAmount</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmountWithVat.htm">CurrencyAmountWithVat</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/DispatchMethod_V1.htm">DispatchMethod_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Event.htm">Event</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Fulfilment.htm">Fulfilment</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm" class="current">Order_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/OrderLine_V1.htm">OrderLine_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/OrderLine_V2.htm">OrderLine_V2</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/ProductPrice.htm">ProductPrice</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Progression_V1.htm">Progression_V1</a>
        </li>
				<li>
            <a href="../Pws.Clients.RestLibrary.Customers.Orders/Release_V1.htm">Release_V1</a>
        </li>
		</ul>
	</div>
</nav>
	<article>
    <header>
		<p class="class"><strong>Type</strong> Order_V1</p>
	</header>
	<section>
		<header>
		<p><strong>Namespace</strong> Pws.Clients.RestLibrary.Customers.Orders</p>
		<p><strong>Interfaces</strong> <a href="../Pws.Clients.RestLibrary/IPwsObject_V1.htm">IPwsObject_V1</a></p>
		</header>
    <div class="sub-header">
			<div id="summary">A customer sales order. <blockquote class="remarks">
  application/x.pws.customers.orders.order-v1 
</blockquote>
			</div>
		
		
		
			<h3 class="section">Properties</h3>
			<ul>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Alerts">Alerts</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#AvailableDispatchMethods">AvailableDispatchMethods</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#AvailableReleaseMethods">AvailableReleaseMethods</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#BuyerContact">BuyerContact</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#CarriageDescription">CarriageDescription</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#CarriageTotal">CarriageTotal</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#DeliveryAddress">DeliveryAddress</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#DiscountTotal">DiscountTotal</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#GoodsTotal">GoodsTotal</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#IsPaymentRequired">IsPaymentRequired</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#IsQuotation">IsQuotation</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#IsUpdateableByCustomer">IsUpdateableByCustomer</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Lines">Lines</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Links">Links</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#OrderDate">OrderDate</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#OrderId">OrderId</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#OrderReference">OrderReference</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#OrderTotal">OrderTotal</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Progression">Progression</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#ReleaseMethod">ReleaseMethod</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#SelectedDispatchMethod">SelectedDispatchMethod</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Status">Status</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Template">Template</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Title">Title</a></li>
				<li><a href="../Pws.Clients.RestLibrary.Customers.Orders/Order_V1.htm#Version">Version</a></li>
			</ul>
		
	</div>
	
	
	
	<h3 class="section">Public properties</h3>

	<div id="Alerts" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Alerts</strong> get; set;
		</h4>
		<div class="content">Alerts that are issued during building up of the order. 

		</div>
	</div>
	<div id="AvailableDispatchMethods" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>AvailableDispatchMethods</strong> get; set;
		</h4>
		<div class="content">A link to the list of dispatch methods which are possible for this order, including
human readable information so that the end user can choose the appropriate method. 

		</div>
	</div>
	<div id="AvailableReleaseMethods" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>AvailableReleaseMethods</strong> get; set;
		</h4>
		<div class="content">A link to the list of release methods that are available for releasing the order. <blockquote class="remarks">
  application/x.pws.customers.orders.release[] 
</blockquote>

		</div>
	</div>
	<div id="BuyerContact" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>BuyerContact</strong> get; set;
		</h4>
		<div class="content">A link to the buyer who is placing the order, as a Contact object.
A contact can also be PUT into here. 

		</div>
	</div>
	<div id="CarriageDescription" class="method">
		<h4>
			<span title="System.string">string</span> <strong>CarriageDescription</strong> get; set;
		</h4>
		<div class="content">A human-readable description of how the carriage charge was arrived at. 

		</div>
	</div>
	<div id="CarriageTotal" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmount.htm">CurrencyAmount</a> <strong>CarriageTotal</strong> get; set;
		</h4>
		<div class="content">The total value of the carriage that has been applied. 

		</div>
	</div>
	<div id="DeliveryAddress" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>DeliveryAddress</strong> get; set;
		</h4>
		<div class="content">A link to the address object that the order will be delivered to.
This link can be PUT to, in order to assign an address object,
either from the customers address list or from a custom generated Address object. 

		</div>
	</div>
	<div id="DiscountTotal" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmount.htm">CurrencyAmount</a> <strong>DiscountTotal</strong> get; set;
		</h4>
		<div class="content">The total value of the discount that has been applied. 

		</div>
	</div>
	<div id="GoodsTotal" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmount.htm">CurrencyAmount</a> <strong>GoodsTotal</strong> get; set;
		</h4>
		<div class="content">The total value of the goods. 

		</div>
	</div>
	<div id="IsPaymentRequired" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsPaymentRequired</strong> get; set;
		</h4>
		<div class="content">Whether this order is suspended pending cash payment. 

		</div>
	</div>
	<div id="IsQuotation" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsQuotation</strong> get; set;
		</h4>
		<div class="content">Whether this is a quotation order - for pricing purposes only, so does not allocate stock. 

		</div>
	</div>
	<div id="IsUpdateableByCustomer" class="method">
		<h4>
			<span title="System.bool">bool</span> <strong>IsUpdateableByCustomer</strong> get; set;
		</h4>
		<div class="content">Whether this order is in a state which is updateable by the customer. I.e. not yet released for picking, and
not locked for internal PWS use. 

		</div>
	</div>
	<div id="Lines" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Lines</strong> get; set;
		</h4>
		<div class="content">A link to the list of lines for this order. This list can be used for retrieval, or for
posting a new line to. 

		</div>
	</div>
	<div id="Links" class="method">
		<h4>
			<span title="System.Collections.Generic.List<Link_V1>">List&lt;Link_V1&gt;</span> <strong>Links</strong> get; set;
		</h4>
		<div class="content">

		</div>
	</div>
	<div id="OrderDate" class="method">
		<h4>
			<span title="System.DateTime">DateTime</span> <strong>OrderDate</strong> get; set;
		</h4>
		<div class="content">The date that the order was raised. 

		</div>
	</div>
	<div id="OrderId" class="method">
		<h4>
			<span title="System.string">string</span> <strong>OrderId</strong> get; set;
		</h4>
		<div class="content">The PWS unique order ID. This is generated automatically when the order is first posted. 

		</div>
	</div>
	<div id="OrderReference" class="method">
		<h4>
			<span title="System.string">string</span> <strong>OrderReference</strong> get; set;
		</h4>
		<div class="content">The customer's own order reference. This must be unique within the customer's own order history. 20 characters maximum. <blockquote class="remarks">
  Required. 
</blockquote>

		</div>
	</div>
	<div id="OrderTotal" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary.Customers.Orders/CurrencyAmountWithVat.htm">CurrencyAmountWithVat</a> <strong>OrderTotal</strong> get; set;
		</h4>
		<div class="content">The total value including the calculated Vat. 

		</div>
	</div>
	<div id="Progression" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Progression</strong> get; set;
		</h4>
		<div class="content">A link to the Progression of the order. This includes pick status, tracking, proof of delivery, etc. 

		</div>
	</div>
	<div id="ReleaseMethod" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>ReleaseMethod</strong> get; set;
		</h4>
		<div class="content">When releasing the order (e.g. "Checkout" has been completed), POST the applicable
Release object to this link address. 

		</div>
	</div>
	<div id="SelectedDispatchMethod" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>SelectedDispatchMethod</strong> get; set;
		</h4>
		<div class="content">A link to the dispatch method that is currently selected for this order.
This link can also be used for a PUT, so that one of the available dispatch methods
can be assigned here. 

		</div>
	</div>
	<div id="Status" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Status</strong> get; set;
		</h4>
		<div class="content">Probably one of Outstanding, Completed, Cancelled... May contain other short information such as pick status. 

		</div>
	</div>
	<div id="Template" class="method">
		<h4>
			<a href="../Pws.Clients.RestLibrary/Link_V1.htm">Link_V1</a> <strong>Template</strong> get; set;
		</h4>
		<div class="content">To copy all the lines from a Template Order into this Order, POST the Template Order to this link. 

		</div>
	</div>
	<div id="Title" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Title</strong> get; set;
		</h4>
		<div class="content">the customer's title for, in particular, template orders, but could apply to any sales order or sales quote. 64 characters maximum. 

		</div>
	</div>
	<div id="Version" class="method">
		<h4>
			<span title="System.string">string</span> <strong>Version</strong> get; set;
		</h4>
		<div class="content">A version checksum of the object. Must be echoed back to the Rest service when issuing a PUT or DELETE. 

		</div>
	</div>
	</section>
	</article><footer>
	<span id="version">Built from v1.0.0.0 of Pws.Clients.RestLibrary</span>
	<span id="docu-link">
		Generated by <a href="http://docu.jagregory.com">docu</a>
	</span>
</footer>
  </body>
</html>